@types/commander

What is @types/commander?

@types/commander provides TypeScript type definitions for the Commander.js library, which is a popular tool for building command-line interfaces (CLI) in Node.js applications.

What are @types/commander's main functionalities?

Command Definition

Defines a command named 'start' with a description and an action to be executed when the command is called.

const { Command } = require('commander');
const program = new Command();
program
  .command('start')
  .description('Start the application')
  .action(() => {
    console.log('Application started');
  });
program.parse(process.argv);

Option Parsing

Defines options for the command-line interface, including a boolean flag and a parameter with a default value.

const { Command } = require('commander');
const program = new Command();
program
  .option('-d, --debug', 'output extra debugging')
  .option('-p, --port <number>', 'port number', 3000);
program.parse(process.argv);
if (program.debug) console.log('Debugging enabled');
console.log(`Port: ${program.port}`);

Subcommands

Defines subcommands under a main command, allowing for more complex command structures.

const { Command } = require('commander');
const program = new Command();
const service = new Command('service');
service
  .command('start')
  .description('Start the service')
  .action(() => {
    console.log('Service started');
  });
service
  .command('stop')
  .description('Stop the service')
  .action(() => {
    console.log('Service stopped');
  });
program.addCommand(service);
program.parse(process.argv);

Other packages similar to @types/commander

yargs

Yargs is another library for building command-line interfaces. It provides a similar feature set to Commander.js, including command and option parsing, but also includes additional features like generating help documentation and handling complex command hierarchies.

oclif

Oclif is a framework for building command-line tools, developed by Heroku. It offers a more structured approach to building CLIs, with built-in support for plugins, testing, and documentation generation. It is more opinionated compared to Commander.js.

meow

Meow is a minimalistic library for building command-line interfaces. It focuses on simplicity and ease of use, making it a good choice for smaller projects or scripts. It provides basic command and option parsing, but lacks some of the advanced features found in Commander.js.

README

This is a stub types definition for @types/commander (https://github.com/tj/commander.js#readme).

commander provides its own type definitions, so you don't need @types/commander installed!